<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenIG: OpenIG::Base::Commands::Command Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="openig_logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">OpenIG
   &#160;<span id="projectnumber">2.0.7</span>
   </div>
   <div id="projectbrief">cross-platform open-source OpenSceneGraph Image Generator</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>OpenIG</b></li><li class="navelem"><b>Base</b></li><li class="navelem"><a class="el" href="class_open_i_g_1_1_base_1_1_commands.html">Commands</a></li><li class="navelem"><a class="el" href="class_open_i_g_1_1_base_1_1_commands_1_1_command.html">Command</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_open_i_g_1_1_base_1_1_commands_1_1_command-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">OpenIG::Base::Commands::Command Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="class_open_i_g_1_1_base_1_1_commands_1_1_command.html" title="The Command class. ">Command</a> class.  
 <a href="class_open_i_g_1_1_base_1_1_commands_1_1_command.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_commands_8h_source.html">Commands.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for OpenIG::Base::Commands::Command:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_open_i_g_1_1_base_1_1_commands_1_1_command.png" usemap="#OpenIG::Base::Commands::Command_map" alt=""/>
  <map id="OpenIG::Base::Commands::Command_map" name="OpenIG::Base::Commands::Command_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acbec1bdb9bdc7c71a8ca1310d6fa1763"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_i_g_1_1_base_1_1_commands_1_1_command.html#acbec1bdb9bdc7c71a8ca1310d6fa1763">exec</a> (const StringUtils::Tokens &amp;tokens)=0</td></tr>
<tr class="memdesc:acbec1bdb9bdc7c71a8ca1310d6fa1763"><td class="mdescLeft">&#160;</td><td class="mdescRight">Custom command execution implementation.  <a href="#acbec1bdb9bdc7c71a8ca1310d6fa1763">More...</a><br /></td></tr>
<tr class="separator:acbec1bdb9bdc7c71a8ca1310d6fa1763"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95f883ebbc814c5434e2693ee8af7b3c"><td class="memItemLeft" align="right" valign="top">virtual const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_i_g_1_1_base_1_1_commands_1_1_command.html#a95f883ebbc814c5434e2693ee8af7b3c">getUsage</a> () const =0</td></tr>
<tr class="memdesc:a95f883ebbc814c5434e2693ee8af7b3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the command usage, brief, like the syntax.  <a href="#a95f883ebbc814c5434e2693ee8af7b3c">More...</a><br /></td></tr>
<tr class="separator:a95f883ebbc814c5434e2693ee8af7b3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3bb6a572136e896aba1336acd7ad10b"><td class="memItemLeft" align="right" valign="top">virtual const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_i_g_1_1_base_1_1_commands_1_1_command.html#ab3bb6a572136e896aba1336acd7ad10b">getDescription</a> () const =0</td></tr>
<tr class="memdesc:ab3bb6a572136e896aba1336acd7ad10b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a detailed command description.  <a href="#ab3bb6a572136e896aba1336acd7ad10b">More...</a><br /></td></tr>
<tr class="separator:ab3bb6a572136e896aba1336acd7ad10b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8051d33cf4b232ebf0ef707c1b73f73f"><td class="memItemLeft" align="right" valign="top">virtual const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_i_g_1_1_base_1_1_commands_1_1_command.html#a8051d33cf4b232ebf0ef707c1b73f73f">getArgumentsFormat</a> () const =0</td></tr>
<tr class="memdesc:a8051d33cf4b232ebf0ef707c1b73f73f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets format of all the arguments. This is the available formats encoded: D - float I - integer S - String {}- List, example: {item1;item2;...} F - File name B - boolean P - position, x y z O - orientation, h p r C - color, r g b an example format can be like this: "F:I:S:{item1;item2;...}:F:B".  <a href="#a8051d33cf4b232ebf0ef707c1b73f73f">More...</a><br /></td></tr>
<tr class="separator:a8051d33cf4b232ebf0ef707c1b73f73f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="class_open_i_g_1_1_base_1_1_commands_1_1_command.html" title="The Command class. ">Command</a> class. </p>
<p>Abstract for a single command </p><dl class="section author"><dt>Author</dt><dd>Trajce Nikolov Nick <a href="#" onclick="location.href='mai'+'lto:'+'ope'+'ni'+'g@c'+'om'+'pro'+'.n'+'et'; return false;">openi<span style="display: none;">.nosp@m.</span>g@co<span style="display: none;">.nosp@m.</span>mpro.<span style="display: none;">.nosp@m.</span>net</a> </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>(c)Compro Computer Services, Inc. </dd></dl>
<dl class="section date"><dt>Date</dt><dd>Sun Jan 11 2015 </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="acbec1bdb9bdc7c71a8ca1310d6fa1763"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbec1bdb9bdc7c71a8ca1310d6fa1763">&#9670;&nbsp;</a></span>exec()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual int OpenIG::Base::Commands::Command::exec </td>
          <td>(</td>
          <td class="paramtype">const StringUtils::Tokens &amp;&#160;</td>
          <td class="paramname"><em>tokens</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Custom command execution implementation. </p>
<p>Inheritants are expected to implement the command execution </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">tokens</td><td>Contains the arguments </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Should return 0 on succes, -1 on failure </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Trajce Nikolov Nick <a href="#" onclick="location.href='mai'+'lto:'+'ope'+'ni'+'g@c'+'om'+'pro'+'.n'+'et'; return false;">openi<span style="display: none;">.nosp@m.</span>g@co<span style="display: none;">.nosp@m.</span>mpro.<span style="display: none;">.nosp@m.</span>net</a> </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>(c)Compro Computer Services, Inc. </dd></dl>
<dl class="section date"><dt>Date</dt><dd>Sun Jan 11 2015 </dd></dl>

</div>
</div>
<a id="a8051d33cf4b232ebf0ef707c1b73f73f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8051d33cf4b232ebf0ef707c1b73f73f">&#9670;&nbsp;</a></span>getArgumentsFormat()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual const std::string OpenIG::Base::Commands::Command::getArgumentsFormat </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets format of all the arguments. This is the available formats encoded: D - float I - integer S - String {}- List, example: {item1;item2;...} F - File name B - boolean P - position, x y z O - orientation, h p r C - color, r g b an example format can be like this: "F:I:S:{item1;item2;...}:F:B". </p>
<dl class="section return"><dt>Returns</dt><dd>The arguments format </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Trajce Nikolov Nick <a href="#" onclick="location.href='mai'+'lto:'+'ope'+'ni'+'g@c'+'om'+'pro'+'.n'+'et'; return false;">openi<span style="display: none;">.nosp@m.</span>g@co<span style="display: none;">.nosp@m.</span>mpro.<span style="display: none;">.nosp@m.</span>net</a> </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>(c)Compro Computer Services, Inc. </dd></dl>
<dl class="section date"><dt>Date</dt><dd>Sat Nov 14 2015 </dd></dl>

</div>
</div>
<a id="ab3bb6a572136e896aba1336acd7ad10b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3bb6a572136e896aba1336acd7ad10b">&#9670;&nbsp;</a></span>getDescription()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual const std::string OpenIG::Base::Commands::Command::getDescription </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets a detailed command description. </p>
<dl class="section return"><dt>Returns</dt><dd>The description </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Trajce Nikolov Nick <a href="#" onclick="location.href='mai'+'lto:'+'ope'+'ni'+'g@c'+'om'+'pro'+'.n'+'et'; return false;">openi<span style="display: none;">.nosp@m.</span>g@co<span style="display: none;">.nosp@m.</span>mpro.<span style="display: none;">.nosp@m.</span>net</a> </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>(c)Compro Computer Services, Inc. </dd></dl>
<dl class="section date"><dt>Date</dt><dd>Sun Jan 11 2015 </dd></dl>

</div>
</div>
<a id="a95f883ebbc814c5434e2693ee8af7b3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95f883ebbc814c5434e2693ee8af7b3c">&#9670;&nbsp;</a></span>getUsage()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual const std::string OpenIG::Base::Commands::Command::getUsage </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets the command usage, brief, like the syntax. </p>
<dl class="section return"><dt>Returns</dt><dd>Brief description on how to use this command </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Trajce Nikolov Nick <a href="#" onclick="location.href='mai'+'lto:'+'ope'+'ni'+'g@c'+'om'+'pro'+'.n'+'et'; return false;">openi<span style="display: none;">.nosp@m.</span>g@co<span style="display: none;">.nosp@m.</span>mpro.<span style="display: none;">.nosp@m.</span>net</a> </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>(c)Compro Computer Services, Inc. </dd></dl>
<dl class="section date"><dt>Date</dt><dd>Sun Jan 11 2015 </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Core-Base/<a class="el" href="_commands_8h_source.html">Commands.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed May 16 2018 15:41:11 for OpenIG by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
